4.5.4.3 查询应用详情-基于名称

可通过此接口基于应用名称查询应用详情。

基本信息

请求地址：https://SDPC-IP:4433/api/v3/resource/queryByName 请求方式：GET

请求头（Header）

点击查看

请求体（Body）

参数	中文名称	必须	类型	描述
name	应用名称	是	string	应用名称

请求示例

基于应用id查询：

curl --location --request GET 'https://SDPC-IP:4433/api/v3/resource/queryByName?name=web1' \
--header 'Content-Type: application/json' \
--header 'X-Ca-Key: {{X-Ca-Key}}' \
--header 'X-Ca-Nonce: {{X-Ca-Nonce}}' \
--header 'X-Ca-TimeStamp: {{X-Ca-TimeStamp}}' \
--header 'X-Ca-Sign: {{X-Ca-Sign}}' \
--header 'Cookie: locale=zh-cn'

响应数据

参数	中文名称	类型	描述
code	响应码	string	`OK` 表示成功，其他表示出错。具体含义请参考错误码定义
data	响应数据	object	应用列表
├─ id	应用ID	string	应用ID
├─ name	应用名称	string	应用名称
├─ description	应用描述	string	应用描述
├─ accessModel	访问模式	string	访问模式： "WEB"表示WEB模式； "L3VPN"表示隧道模式
├─ subModel	访问子模式	string	访问子模式： "WEB"表示标准WEB； "L3VPN"表示标准隧道 "TUN2WEB"表示隧道转web模式
├─ groupId	应用分类id	string	所属应用分类ID
├─ groupName	应用分类名称	string	所属应用分类名称
├─ nodeGroupId	所属节点id	string	节点区域ID
├─ nodeGroupName	所属节点名称	string	节点区域名称
├─ addressList	后端服务器地址列表	object []	后端服务器地址列表，仅隧道应用
├─ ├─ protocol	协议	string	协议
├─ ├─ host	地址	string	地址
├─ ├─ port	端口	string	端口
├─ excludeAddress	排除地址配置	object	排除地址配置
├─ ├─ status	排除地址启用状态	number	排除地址启用状态，0启用，1禁用
├─ ├─ excludeAddressList	排除地址列表	object[]	排除地址列表数组
├─ ├─ ├─ host	地址	string	地址
├─ ├─ ├─ port	端口	string	端口
├─ ├─ ├─ protocol	协议	string	协议
├─ appAddress	后端服务器地址	string	后端服务器地址，仅web应用
├─ accessAddress	前端访问地址	string	前端访问地址，仅web应用
├─ accessEntry	浏览器打开地址	string	浏览器打开地址
├─ accessAddressAliasList	前端访问地址别名列表	object []	前端访问地址别名列表，仅web应用
├─ ├─ protocol	协议	string	协议
├─ ├─ host	地址	string	地址
├─ ├─ port	端口	string	端口
├─ status	应用状态	number	应用启用状态，0：禁用；1：启用
├─ allowApply	是否允许自助申请	number	是否允许用户自助申请此应用权限权限
├─ iconId	应用图标id	string	应用图标id
├─ iconPath	应用图标路径	string	应用图标路径
├─ iconType	应用图标类型	string	应用图标类型
├─ enableAuthFree	免认证启用状态	number	免认证启用状态
├─ trustedCertId	授信证书id	string	授信证书id
├─ trustedCertName	授信证书名称	string	授信证书名称
├─ enableTransparentProxy	是否启用透明代理	number	1表示透明代理模式，0表示智能改写模式
├─ isHide	应用可见性	number	应用可见性，0表示允许用户可见（显示在应用中心）， 1表示用户不可见（不显示在应用中心）
├─ authFreeIp	ip限制	object[]	当authFreeIp为空数组且enableAuthFree为1时，表示全部IP免认证；当authFreeIp为非空数组且enableAuthFree为1时，表示指定IP免认证；
├─ pathList	访问路径范围	object []	访问路径范围
├─├─ desc	描述	string	描述
├─├─ path	路径	string	路径
├─ excludePathStatus	排除路径范围启用状态	number	排除路径范围启用状态，1表示启用，0表示禁用
├─ excludePathList	排除路径范围	object []	排除路径范围
├─├─ desc	描述	string	描述
├─├─ path	路径	string	路径
├─ enableLoadBalance	是否启用负载均衡	number	是否启用负载均衡，1表示启用，0表示禁用
├─ macOpenModel	mac平台打开方式	string	mac平台打开方式，默认为"default-browser"
├─ linuxOpenModel	linux平台打开方式	string	linux平台打开方式，默认为"default-browser"
├─ windowsOpenModel	windows打开方式	string	windows打开方式，默认为"default-browser"
├─ watermarkEnable	是否开启水印	number	是否开启水印，1表示启用，0表示禁用
├─ enableTCPPrefL3	是否开启隧道长连接	boolean	是否开启隧道长连接，1表示启用，0表示禁用
msg	描述信息	string	描述信息
traceId	调用链id	string

返回示例

{
    "code": "OK",
    "data": {
        "id": "4cffbdb0-daf7-11ee-99c1-ad5ce62be579",
        "name": "web1",
        "description": "testaaa",
        "accessModel": "WEB",
        "subModel": "WEB",
        "groupId": "default",
        "groupName": "默认分类",
        "nodeGroupId": "162a5d3c-2266-4643-9c50-c5e619fa7e6e",
        "excludeAddress": {
            "status": 0,
            "excludeAddressList": []
        },
        "appAddress": "https://1.2.3.4",
        "accessAddress": "https://test.com",
        "accessEntry": "https://test.com/客服体系/专家中心/零信任专家组",
        "status": 1,
        "allowApply": 1,
        "iconId": "1",
        "iconPath": "/portal/preset_icon/batch333_000.png",
        "iconType": "font",
        "enableAuthFree": 1,
        "trustedCertId": "default",
        "trustedCertName": "内置web应用证书（国际密码标准）",
        "isHide": 0,
        "authFreeIp": [],
        "pathList": [
            {
                "desc": "heihei",
                "path": "/客服体系/专家中心/*"
            }
        ],
        "excludePathStatus": 1,
        "excludePathList": [
            {
                "desc": "paichu范围",
                "path": "/客服体系/专家中心/零信任专家组/d"
            }
        ],
        "enableLoadBalance": 0,
        "macOpenModel": "default-browser",
        "linuxOpenModel": "default-browser",
        "windowsOpenModel": "default-browser",
        "watermarkEnable": 1,
        "enableTCPPrefL3": false
    },
    "msg": "请求成功",
    "traceId": "00302c8803d10172"
}

错误码

点击查看

4.5.4.3 查询应用详情-基于名称

4.5.4.3 查询应用详情-基于名称

results matching ""

No results matching ""